Circle Avatar
Type
widget
Summary
This widget is to display the avatar of a user.
Description
Circle Avatar is a widget used to display a user's profile image or, in the absence of such an image, the user's initials.
Compatibility and Support
OS
mac
windows
linux
ios
android
web
Platforms
desktop
mobile
web
Associated Syntax
Property
| Name | Summary | Syntax |
|---|---|---|
| avatarIcon | Specifies the name of the icon shown in the avatar. | set the avatarIcon of widget to {<IconName>} get the avatarIcon of widget |
| text | Specifies the text contained by avatar image. | set the text of widget to <string> get the text of widget |
| badgeColor | Specifies the color of the icon or text shown in the Badge. | set the badgeColor of widget to {<RGB Color>} get the badgeColor of widget |
| showAvatarIcon | Defines whether to display the avatar icon or not. | set the showAvatarIcon of widget to {<true> | <false>} get the showAvatarIcon of widget |
| badgeLineSize | Specifies the thickness of the borders of the badge. | set the badgeLineSize of widget to {<integer>} get the badgeLineSize of widget |
| badgeLabel | Specifies the text shown in the Badge. | set the badgeLabel of widget to {<string>} get the badgeLabel of widget |
| roundedRadius | Specifies the radius of the avatar's corners. | set the roundedRadius of widget to {<integer>} get the roundedRadius of widget |
| angleBadge | Specifies the angle at which the badge is drawn on the widget. | set the angleBadge of widget to {<integer>} get the angleBadge of widget |
| label | Specifies the string that represents the username. | set the label of widget to {<labelString>} get the label of widget |
| avatarShape | Specifies the shape of the avatar. | set the avatarShape of widget to {"circle" | "rectangle"} get the avatarShape of widget |
| badgeBackgroundColor | Specifies the background color of the badge. | set the badgeBackColor of widget to {<RGB Color>} get the badgeBackColor of widget |
| lineSize | Specifies the thickness of the widget's borders | set the lineSize of widget to <integer> get the lineSize of widget |
| variant | The variant to use. | set the variant of widget to {"circular" | "rounded" | "square"} get the variant of widget |
| alignImage | Specifies how the image is aligned in the widget. | set the alignImage of widget to {<topLeft> | <topCenter> | <topRight> | <centerLeft> | <center> | <centerRight> | <bottomLeft> | <bottomCenter> | <bottomRight>} get the alignImage of widget |
| badgeBorderColor | Specifies the border color of the badge. | set the badgeBorderColor of widget to {<RGB Color>} get the badgeBorderColor of widget |
| filename | Specifies the file associated with the user's avatar image. | set the filename of widget to <filePath> get the filename of widget |
| badgeRadius | Specifies the radius that the circle of the badge will have. | set the badgeRadius of widget to {<integer>} get the badgeRadius of widget |
| badgeIcon | Specifies the name of the icon shown in the Badge. | set the badgeIcon of widget to {<IconName>} get the badgeIcon of widget |
| showBadge | Defines whether to display the badge or not. | set the showBadge of widget to {<true> | <false>} get the showBadge of widget |
| personalizedFonts | Specifies whether to use custom fonts or the default font. | set the personalizedFonts of widget to {<true> | <false>} get the personalizedFonts of widget |
| badgePadding | Specifies the padding of the content that is drawn on the badge. | set the badgePadding of widget to {<integer>} get the badgePadding of widget |
| badgeType | Specifies the type of content that is drawn on the badge. | set the badgeType of widget to {<empty> | <shortText> | <iconName>} get the badgeType of widget |